/*
 * Copyright (c) 2013, marco.tamburelli@gmail.com
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met: 
 * 
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.omorphdb.core.storage.document;

import org.omorphdb.core.storage.DocumentStatus;

/**
 * Contains information describing a document properties.
 */
public interface DocumentDescriptor
{
	/**
	 * The unique integer number identifying the document. <br>
	 * <br>
	 * The value can be null, in such case it means that the document was just
	 * created.
	 * 
	 * @return
	 */
	Long getDefaultKey();

	/**
	 * Returns an element from {@link DocumentStatus} representing the status of
	 * the document.
	 * 
	 * @return
	 */
	DocumentStatus getDocumentStatus();

	/**
	 * Returns true in case the document has been updated. In case of a new
	 * document this function returns always true.
	 * 
	 * @return
	 */
	boolean isUpdated();

	/**
	 * Returns the number of attributes defined within the owning document.
	 * 
	 * @return
	 */
	int getAttributesCount();

	/**
	 * The position of the document within the storage file.
	 * 
	 * @return
	 */
	long getDocumentPosition();

	/**
	 * The length of the document in bytes (note that it calculates only the
	 * part with values).
	 * 
	 * @return
	 */
	int getDocumentSize();

	/**
	 * Returns the unique ID of the class the document represents.
	 * 
	 * @return
	 */
	int getClassID();
}
